Fixes #134: add xr.Dataset as input type for appropriate modules#854
Merged
brendancol merged 2 commits intomasterfrom Feb 20, 2026
Merged
Conversation
Add transparent Dataset support via two decorators in a new dataset_support module. Single-input functions (slope, aspect, curvature, hillshade, focal.mean, 10 classify functions, 3 proximity functions) iterate over data_vars and return a Dataset. Multi-input functions (10 multispectral indices) accept a Dataset with band-name kwargs. zonal.stats merges per-variable DataFrames with prefixed columns. Includes 18 new tests.
Update docstrings, prose docs, notebooks, README, and changelog to reflect that most public functions now accept xr.Dataset in addition to xr.DataArray.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
xr.Datasetsupport to ~25 public functions via two new decorators inxrspatial/dataset_support.py:@supports_dataset(single-input functions): iterates overdata_vars, calls the original function on each, returns a new Dataset. Applied toslope,aspect,curvature,hillshade,focal.mean, 10 classify functions, and 3 proximity functions.@supports_dataset_bands(multi-input functions): accepts a Dataset with band-name keyword arguments (e.g.ndvi(ds, nir='B8', red='B4')). Applied to 10 multispectral index functions.zonal.stats: runs per-variable, prefixes stat columns with the variable name, and merges into a single DataFrame.xr.DataArraycall paths are completely unchanged (passthrough).Test plan
test_dataset_support.pycovering all three patterns (single-input, multi-input, zonal stats), including error casesCloses #134